AddSparkline(SheetCellRange[],CellRange[],SparklineType,ExcelSparklineSetting) Method

Adds the sparkline.

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function AddSparkline( _
   ByVal data() As SheetCellRange, _
   ByVal location() As CellRange, _
   ByVal type As SparklineType, _
   ByVal setting As ExcelSparklineSetting _
) As ExcelSparklineGroup

'Usage
 
Dim instance As SheetView
Dim data() As SheetCellRange
Dim location() As CellRange
Dim type As SparklineType
Dim setting As ExcelSparklineSetting
Dim value As ExcelSparklineGroup
 
value = instance.AddSparkline(data, location, type, setting)

public ExcelSparklineGroup AddSparkline( 
   SheetCellRange[] data,
   CellRange[] location,
   SparklineType type,
   ExcelSparklineSetting setting
)

Parameters

data: Data
location: Location of sparkline
type: Type of sparkline
setting: Setting

Remarks

The data for the sparkline is limited to one column or row of values.

Example

This example creates a sparkline in a cell.

FarPoint.Win.Spread.SheetView sv = new FarPoint.Win.Spread.SheetView();
FarPoint.Win.Spread.Chart.SheetCellRange[] test = new FarPoint.Win.Spread.Chart.SheetCellRange[2];
test[0] = new FarPoint.Win.Spread.Chart.SheetCellRange(sv, 0, 0, 1, 5);
FarPoint.Win.Spread.Chart.SheetCellRange[] data2 = new FarPoint.Win.Spread.Chart.SheetCellRange[2];
data2[0] = new FarPoint.Win.Spread.Chart.SheetCellRange(sv, 5, 0, 1, 1);

FarPoint.Win.Spread.ExcelSparklineSetting ex = new FarPoint.Win.Spread.ExcelSparklineSetting();
fpSpread1.Sheets[0] = sv;
sv.Cells[0, 0].Value = 2;
sv.Cells[0, 1].Value = 5;
sv.Cells[0, 2].Value = 4;
sv.Cells[0, 3].Value = -1;
sv.Cells[0, 4].Value = 3;

fpSpread1.Sheets[0].AddSparkline(test[0], data2[0], FarPoint.Win.Spread.SparklineType.Column, ex);

Visual Basic

Dim sv As New FarPoint.Win.Spread.SheetView()
Dim test(1) As FarPoint.Win.Spread.Chart.SheetCellRange
test(0) = New FarPoint.Win.Spread.Chart.SheetCellRange(sv, 0, 0, 1, 5)
Dim data2(1) As FarPoint.Win.Spread.Chart.SheetCellRange
data2(0) = New FarPoint.Win.Spread.Chart.SheetCellRange(sv, 5, 0, 1, 1)

Dim ex As New FarPoint.Win.Spread.ExcelSparklineSetting()
FpSpread1.Sheets(0) = sv
sv.Cells(0, 0).Value = 2
sv.Cells(0, 1).Value = 5
sv.Cells(0, 2).Value = 4
sv.Cells(0, 3).Value = -1
sv.Cells(0, 4).Value = 3

FpSpread1.Sheets(0).AddSparkline(test(0), data2(0), FarPoint.Win.Spread.SparklineType.Column, ex)

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

SheetView Class
SheetView Members
Overload List